Skip to content

docs(validation): add main docs page #3717

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Mar 13, 2025
Merged

docs(validation): add main docs page #3717

merged 6 commits into from
Mar 13, 2025

Conversation

dreamorosi
Copy link
Contributor

Summary

Changes

Please provide a summary of what's being changed

This PR revisits the documentation page for the upcoming Validation utility and extracts the code snippets in the examples/snippets directory.

Prior to this PR we already had a draft of the documentation that was written before the implementation. As part of this PR I reviewed each code snippet and the text to make sure it's accurate with what was implemented.

Please add the issue number below, if no issue is present the PR might get blocked and not be reviewed

Issue number: closes #3716


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@dreamorosi dreamorosi requested a review from am29d March 12, 2025 16:26
@dreamorosi dreamorosi self-assigned this Mar 12, 2025
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Mar 12, 2025
@pull-request-size pull-request-size bot added the size/XL PRs between 500-999 LOC, often PRs that grown with feedback label Mar 12, 2025
@am29d am29d merged commit 4f8b15a into main Mar 13, 2025
41 checks passed
@am29d am29d deleted the docs/validation_utility branch March 13, 2025 08:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size/XL PRs between 500-999 LOC, often PRs that grown with feedback
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: review Validation documentation
2 participants